<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.beanutils.expression;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    /**<a name="line.19"></a>
<FONT color="green">020</FONT>     * Property Name Expression Resolver.<a name="line.20"></a>
<FONT color="green">021</FONT>     * &lt;p&gt;<a name="line.21"></a>
<FONT color="green">022</FONT>     * Methods such as PropertyUtilsBean's &lt;code&gt;setNestedProperty()&lt;/code&gt; method<a name="line.22"></a>
<FONT color="green">023</FONT>     * use a &lt;code&gt;Resolver&lt;/code&gt; to process a &lt;i&gt;property name&lt;/i&gt;<a name="line.23"></a>
<FONT color="green">024</FONT>     * expression and resolve &lt;i&gt;nested&lt;/i&gt;, &lt;i&gt;indexed&lt;/i&gt; and &lt;i&gt;mapped&lt;/i&gt;<a name="line.24"></a>
<FONT color="green">025</FONT>     * property names. The following code provides an example usage<a name="line.25"></a>
<FONT color="green">026</FONT>     * demonstrating all the methods:<a name="line.26"></a>
<FONT color="green">027</FONT>     *<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;pre&gt;<a name="line.28"></a>
<FONT color="green">029</FONT>     *      // Iterate through a nested property expression<a name="line.29"></a>
<FONT color="green">030</FONT>     *      while (resolver.hasNested(name)) {<a name="line.30"></a>
<FONT color="green">031</FONT>     *<a name="line.31"></a>
<FONT color="green">032</FONT>     *          // isolate a single property from a nested expresion<a name="line.32"></a>
<FONT color="green">033</FONT>     *          String next = resolver.next(name);<a name="line.33"></a>
<FONT color="green">034</FONT>     *<a name="line.34"></a>
<FONT color="green">035</FONT>     *          // Process...<a name="line.35"></a>
<FONT color="green">036</FONT>     *          String property = resolver.getProperty(next);<a name="line.36"></a>
<FONT color="green">037</FONT>     *          if (resolver.isIndexed(next)) {<a name="line.37"></a>
<FONT color="green">038</FONT>     *<a name="line.38"></a>
<FONT color="green">039</FONT>     *              int index = resolver.getIndex(next);<a name="line.39"></a>
<FONT color="green">040</FONT>     *              bean = getIndexedProperty(bean, property, index);<a name="line.40"></a>
<FONT color="green">041</FONT>     *<a name="line.41"></a>
<FONT color="green">042</FONT>     *          } else if (resolver.isMapped(next)) {<a name="line.42"></a>
<FONT color="green">043</FONT>     *<a name="line.43"></a>
<FONT color="green">044</FONT>     *              String key = resolver.getKey(next);<a name="line.44"></a>
<FONT color="green">045</FONT>     *              bean = getMappedProperty(bean, property, key);<a name="line.45"></a>
<FONT color="green">046</FONT>     *<a name="line.46"></a>
<FONT color="green">047</FONT>     *          } else {<a name="line.47"></a>
<FONT color="green">048</FONT>     *<a name="line.48"></a>
<FONT color="green">049</FONT>     *              bean = getSimpleProperty(bean, property);<a name="line.49"></a>
<FONT color="green">050</FONT>     *<a name="line.50"></a>
<FONT color="green">051</FONT>     *          }<a name="line.51"></a>
<FONT color="green">052</FONT>     *<a name="line.52"></a>
<FONT color="green">053</FONT>     *          // remove the processed property from the expression<a name="line.53"></a>
<FONT color="green">054</FONT>     *          name = resolver.remove(name);<a name="line.54"></a>
<FONT color="green">055</FONT>     *      }<a name="line.55"></a>
<FONT color="green">056</FONT>     * &lt;/pre&gt;<a name="line.56"></a>
<FONT color="green">057</FONT>     *<a name="line.57"></a>
<FONT color="green">058</FONT>     * In order to create an implementation, it is important to understand how<a name="line.58"></a>
<FONT color="green">059</FONT>     * BeanUtils/PropertyUtils uses the &lt;code&gt;resolver&lt;/code&gt;. The following are<a name="line.59"></a>
<FONT color="green">060</FONT>     * the main methods that use it:<a name="line.60"></a>
<FONT color="green">061</FONT>     * &lt;ul&gt;<a name="line.61"></a>
<FONT color="green">062</FONT>     *   &lt;li&gt;{@link org.apache.commons.beanutils.PropertyUtilsBean}&lt;/li&gt;<a name="line.62"></a>
<FONT color="green">063</FONT>     *   &lt;ul&gt;<a name="line.63"></a>
<FONT color="green">064</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.PropertyUtilsBean#getIndexedProperty(Object, String)}&lt;/li&gt;<a name="line.64"></a>
<FONT color="green">065</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.PropertyUtilsBean#getMappedProperty(Object, String)}&lt;/li&gt;<a name="line.65"></a>
<FONT color="green">066</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.PropertyUtilsBean#getNestedProperty(Object, String)}&lt;/li&gt;<a name="line.66"></a>
<FONT color="green">067</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.PropertyUtilsBean#getPropertyDescriptor(Object, String)}&lt;/li&gt;<a name="line.67"></a>
<FONT color="green">068</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.PropertyUtilsBean#getSimpleProperty(Object, String)}&lt;/li&gt;<a name="line.68"></a>
<FONT color="green">069</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.PropertyUtilsBean#setIndexedProperty(Object, String, Object)}&lt;/li&gt;<a name="line.69"></a>
<FONT color="green">070</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.PropertyUtilsBean#setMappedProperty(Object, String, Object)}&lt;/li&gt;<a name="line.70"></a>
<FONT color="green">071</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.PropertyUtilsBean#setNestedProperty(Object, String, Object)}&lt;/li&gt;<a name="line.71"></a>
<FONT color="green">072</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.PropertyUtilsBean#setSimpleProperty(Object, String, Object)}&lt;/li&gt;<a name="line.72"></a>
<FONT color="green">073</FONT>     *   &lt;/ul&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>     *   &lt;li&gt;{@link org.apache.commons.beanutils.BeanUtilsBean}&lt;/li&gt;<a name="line.74"></a>
<FONT color="green">075</FONT>     *   &lt;ul&gt;<a name="line.75"></a>
<FONT color="green">076</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.BeanUtilsBean#copyProperty(Object, String, Object)}&lt;/li&gt;<a name="line.76"></a>
<FONT color="green">077</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.BeanUtilsBean#setProperty(Object, String, Object)}&lt;/li&gt;<a name="line.77"></a>
<FONT color="green">078</FONT>     *   &lt;/ul&gt;<a name="line.78"></a>
<FONT color="green">079</FONT>     *   &lt;li&gt;{@link org.apache.commons.beanutils.locale.LocaleBeanUtilsBean}&lt;/li&gt;<a name="line.79"></a>
<FONT color="green">080</FONT>     *   &lt;ul&gt;<a name="line.80"></a>
<FONT color="green">081</FONT>     *       &lt;li&gt;{@link org.apache.commons.beanutils.locale.LocaleBeanUtilsBean#setProperty(Object,<a name="line.81"></a>
<FONT color="green">082</FONT>     *        String, Object, String)}&lt;/li&gt;<a name="line.82"></a>
<FONT color="green">083</FONT>     *   &lt;/ul&gt;<a name="line.83"></a>
<FONT color="green">084</FONT>     * &lt;/ul&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>     *<a name="line.85"></a>
<FONT color="green">086</FONT>     * @version $Revision: 555845 $ $Date: 2007-07-13 03:52:05 +0100 (Fri, 13 Jul 2007) $<a name="line.86"></a>
<FONT color="green">087</FONT>     * @see org.apache.commons.beanutils.PropertyUtilsBean#setResolver(Resolver)<a name="line.87"></a>
<FONT color="green">088</FONT>     * @since 1.8.0<a name="line.88"></a>
<FONT color="green">089</FONT>     */<a name="line.89"></a>
<FONT color="green">090</FONT>    public interface Resolver {<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>        /**<a name="line.92"></a>
<FONT color="green">093</FONT>         * Extract the index value from the property expression or -1.<a name="line.93"></a>
<FONT color="green">094</FONT>         *<a name="line.94"></a>
<FONT color="green">095</FONT>         * @param expression The property expression<a name="line.95"></a>
<FONT color="green">096</FONT>         * @return The index value or -1 if the property is not indexed<a name="line.96"></a>
<FONT color="green">097</FONT>         * @throws IllegalArgumentException If the indexed property is illegally<a name="line.97"></a>
<FONT color="green">098</FONT>         * formed or has an invalid (non-numeric) value<a name="line.98"></a>
<FONT color="green">099</FONT>         */<a name="line.99"></a>
<FONT color="green">100</FONT>        int getIndex(String expression);<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>        /**<a name="line.102"></a>
<FONT color="green">103</FONT>         * Extract the map key from the property expression or &lt;code&gt;null&lt;/code&gt;.<a name="line.103"></a>
<FONT color="green">104</FONT>         *<a name="line.104"></a>
<FONT color="green">105</FONT>         * @param expression The property expression<a name="line.105"></a>
<FONT color="green">106</FONT>         * @return The index value<a name="line.106"></a>
<FONT color="green">107</FONT>         * @throws IllegalArgumentException If the mapped property is illegally formed<a name="line.107"></a>
<FONT color="green">108</FONT>         */<a name="line.108"></a>
<FONT color="green">109</FONT>        String getKey(String expression);<a name="line.109"></a>
<FONT color="green">110</FONT>    <a name="line.110"></a>
<FONT color="green">111</FONT>        /**<a name="line.111"></a>
<FONT color="green">112</FONT>         * Return the property name from the property expression.<a name="line.112"></a>
<FONT color="green">113</FONT>         *<a name="line.113"></a>
<FONT color="green">114</FONT>         * @param expression The property expression<a name="line.114"></a>
<FONT color="green">115</FONT>         * @return The property name<a name="line.115"></a>
<FONT color="green">116</FONT>         */<a name="line.116"></a>
<FONT color="green">117</FONT>        String getProperty(String expression);<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>        /**<a name="line.119"></a>
<FONT color="green">120</FONT>         * Indicates whether or not the expression<a name="line.120"></a>
<FONT color="green">121</FONT>         * contains nested property expressions or not.<a name="line.121"></a>
<FONT color="green">122</FONT>         *<a name="line.122"></a>
<FONT color="green">123</FONT>         * @param expression The property expression<a name="line.123"></a>
<FONT color="green">124</FONT>         * @return The next property expression<a name="line.124"></a>
<FONT color="green">125</FONT>         */<a name="line.125"></a>
<FONT color="green">126</FONT>        boolean hasNested(String expression);<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>        /**<a name="line.128"></a>
<FONT color="green">129</FONT>         * Indicate whether the expression is for an indexed property or not.<a name="line.129"></a>
<FONT color="green">130</FONT>         *<a name="line.130"></a>
<FONT color="green">131</FONT>         * @param expression The property expression<a name="line.131"></a>
<FONT color="green">132</FONT>         * @return &lt;code&gt;true&lt;/code&gt; if the expresion is indexed,<a name="line.132"></a>
<FONT color="green">133</FONT>         *  otherwise &lt;code&gt;false&lt;/code&gt;<a name="line.133"></a>
<FONT color="green">134</FONT>         */<a name="line.134"></a>
<FONT color="green">135</FONT>        boolean isIndexed(String expression);<a name="line.135"></a>
<FONT color="green">136</FONT>    <a name="line.136"></a>
<FONT color="green">137</FONT>        /**<a name="line.137"></a>
<FONT color="green">138</FONT>         * Indicate whether the expression is for a mapped property or not.<a name="line.138"></a>
<FONT color="green">139</FONT>         *<a name="line.139"></a>
<FONT color="green">140</FONT>         * @param expression The property expression<a name="line.140"></a>
<FONT color="green">141</FONT>         * @return &lt;code&gt;true&lt;/code&gt; if the expresion is mapped,<a name="line.141"></a>
<FONT color="green">142</FONT>         *  otherwise &lt;code&gt;false&lt;/code&gt;<a name="line.142"></a>
<FONT color="green">143</FONT>         */<a name="line.143"></a>
<FONT color="green">144</FONT>        boolean isMapped(String expression);<a name="line.144"></a>
<FONT color="green">145</FONT>    <a name="line.145"></a>
<FONT color="green">146</FONT>        /**<a name="line.146"></a>
<FONT color="green">147</FONT>         * Extract the next property expression from the<a name="line.147"></a>
<FONT color="green">148</FONT>         * current expression.<a name="line.148"></a>
<FONT color="green">149</FONT>         *<a name="line.149"></a>
<FONT color="green">150</FONT>         * @param expression The property expression<a name="line.150"></a>
<FONT color="green">151</FONT>         * @return The next property expression<a name="line.151"></a>
<FONT color="green">152</FONT>         */<a name="line.152"></a>
<FONT color="green">153</FONT>        String next(String expression);<a name="line.153"></a>
<FONT color="green">154</FONT>    <a name="line.154"></a>
<FONT color="green">155</FONT>        /**<a name="line.155"></a>
<FONT color="green">156</FONT>         * Remove the last property expresson from the<a name="line.156"></a>
<FONT color="green">157</FONT>         * current expression.<a name="line.157"></a>
<FONT color="green">158</FONT>         *<a name="line.158"></a>
<FONT color="green">159</FONT>         * @param expression The property expression<a name="line.159"></a>
<FONT color="green">160</FONT>         * @return The new expression value, with first property<a name="line.160"></a>
<FONT color="green">161</FONT>         * expression removed - null if there are no more expressions<a name="line.161"></a>
<FONT color="green">162</FONT>         */<a name="line.162"></a>
<FONT color="green">163</FONT>        String remove(String expression);<a name="line.163"></a>
<FONT color="green">164</FONT>    <a name="line.164"></a>
<FONT color="green">165</FONT>    }<a name="line.165"></a>




























































</PRE>
</BODY>
</HTML>
